\hypertarget{class_xbox_joystick}{\section{Xbox\-Joystick Class Reference}
\label{class_xbox_joystick}\index{Xbox\-Joystick@{Xbox\-Joystick}}
}


{\ttfamily \#include $<$Xbox\-Joystick.\-hpp$>$}

Inheritance diagram for Xbox\-Joystick\-:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{class_xbox_joystick}
\end{center}
\end{figure}
\subsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
enum \hyperlink{class_xbox_joystick_aaa756144cc7f7963ac76492964f1e560}{Xbox\-Axis} \{ {\bfseries k\-Left\-X} = 1, 
{\bfseries k\-Left\-Y} = 2, 
{\bfseries k\-Right\-X} = 4, 
{\bfseries k\-Right\-Y} = 5
 \}
\item 
enum \hyperlink{class_xbox_joystick_ac7111bc0fe9e0ba262132450210b0c54}{Xbox\-Button} \{ \\*
{\bfseries k\-A} = 0, 
{\bfseries k\-B} = 1, 
{\bfseries k\-X} = 2, 
{\bfseries k\-Y} = 3, 
\\*
{\bfseries k\-Lb} = 4, 
{\bfseries k\-Rb} = 5, 
{\bfseries k\-Back} = 6, 
{\bfseries k\-Start} = 7, 
\\*
{\bfseries k\-Right\-Stick\-Press} = 8, 
{\bfseries k\-Left\-Stick\-Press} = 9
 \}
\end{DoxyCompactItemize}
\subsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\hyperlink{class_xbox_joystick_a5a83202d3dc4c615b9100b22139b3bec}{Xbox\-Joystick} (int joystick\-Port)
\item 
virtual \hyperlink{class_xbox_joystick_abb5223c147803869462e1db8dce37df6}{$\sim$\-Xbox\-Joystick} ()
\item 
double \hyperlink{class_xbox_joystick_a5afd1e7c0ee438b77ea084711019da30}{Get\-Axis\-Value} (\hyperlink{class_xbox_joystick_aaa756144cc7f7963ac76492964f1e560}{Xbox\-Axis} axis)
\item 
bool \hyperlink{class_xbox_joystick_a5b6bc91395f531f2d2c3fd4de75ac25c}{Get\-Button} (\hyperlink{class_xbox_joystick_ac7111bc0fe9e0ba262132450210b0c54}{Xbox\-Button} button)
\item 
bool \hyperlink{class_xbox_joystick_a7208078a5e146a0e3775419feb215c30}{Get\-Right\-Trigger} ()
\item 
bool \hyperlink{class_xbox_joystick_ac3da3450671b6ceba83b41df7911380d}{Get\-Left\-Trigger} ()
\end{DoxyCompactItemize}


\subsection{Detailed Description}
The \hyperlink{class_xbox_joystick}{Xbox\-Joystick} class allows you to receive input data from an X\-Box controller. 

\subsection{Member Enumeration Documentation}
\hypertarget{class_xbox_joystick_aaa756144cc7f7963ac76492964f1e560}{\index{Xbox\-Joystick@{Xbox\-Joystick}!Xbox\-Axis@{Xbox\-Axis}}
\index{Xbox\-Axis@{Xbox\-Axis}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{Xbox\-Axis}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Xbox\-Joystick\-::\-Xbox\-Axis}}}\label{class_xbox_joystick_aaa756144cc7f7963ac76492964f1e560}
The Xbox\-Axis enum specifies which axis of which analog stick to read from. \hypertarget{class_xbox_joystick_ac7111bc0fe9e0ba262132450210b0c54}{\index{Xbox\-Joystick@{Xbox\-Joystick}!Xbox\-Button@{Xbox\-Button}}
\index{Xbox\-Button@{Xbox\-Button}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{Xbox\-Button}]{\setlength{\rightskip}{0pt plus 5cm}enum {\bf Xbox\-Joystick\-::\-Xbox\-Button}}}\label{class_xbox_joystick_ac7111bc0fe9e0ba262132450210b0c54}
The Xbox\-Button enum specifies which button to read from. 

\subsection{Constructor \& Destructor Documentation}
\hypertarget{class_xbox_joystick_a5a83202d3dc4c615b9100b22139b3bec}{\index{Xbox\-Joystick@{Xbox\-Joystick}!Xbox\-Joystick@{Xbox\-Joystick}}
\index{Xbox\-Joystick@{Xbox\-Joystick}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{Xbox\-Joystick}]{\setlength{\rightskip}{0pt plus 5cm}Xbox\-Joystick\-::\-Xbox\-Joystick (
\begin{DoxyParamCaption}
\item[{int}]{joystick\-Port}
\end{DoxyParamCaption}
)}}\label{class_xbox_joystick_a5a83202d3dc4c615b9100b22139b3bec}
Constructor for \hyperlink{class_xbox_joystick}{Xbox\-Joystick}.


\begin{DoxyParams}{Parameters}
{\em joystick\-Port} & The port number that the X\-Box controller is plugged into. \\
\hline
\end{DoxyParams}
\hypertarget{class_xbox_joystick_abb5223c147803869462e1db8dce37df6}{\index{Xbox\-Joystick@{Xbox\-Joystick}!$\sim$\-Xbox\-Joystick@{$\sim$\-Xbox\-Joystick}}
\index{$\sim$\-Xbox\-Joystick@{$\sim$\-Xbox\-Joystick}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{$\sim$\-Xbox\-Joystick}]{\setlength{\rightskip}{0pt plus 5cm}Xbox\-Joystick\-::$\sim$\-Xbox\-Joystick (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)\hspace{0.3cm}{\ttfamily [virtual]}}}\label{class_xbox_joystick_abb5223c147803869462e1db8dce37df6}
Destructor for \hyperlink{class_xbox_joystick}{Xbox\-Joystick}. 

\subsection{Member Function Documentation}
\hypertarget{class_xbox_joystick_a5afd1e7c0ee438b77ea084711019da30}{\index{Xbox\-Joystick@{Xbox\-Joystick}!Get\-Axis\-Value@{Get\-Axis\-Value}}
\index{Get\-Axis\-Value@{Get\-Axis\-Value}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{Get\-Axis\-Value}]{\setlength{\rightskip}{0pt plus 5cm}double Xbox\-Joystick\-::\-Get\-Axis\-Value (
\begin{DoxyParamCaption}
\item[{{\bf Xbox\-Axis}}]{axis}
\end{DoxyParamCaption}
)}}\label{class_xbox_joystick_a5afd1e7c0ee438b77ea084711019da30}
Get the current value of the specified axis.


\begin{DoxyParams}{Parameters}
{\em axis} & The Xbox\-Axis to read from. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The current value of the axis. 
\end{DoxyReturn}
\hypertarget{class_xbox_joystick_a5b6bc91395f531f2d2c3fd4de75ac25c}{\index{Xbox\-Joystick@{Xbox\-Joystick}!Get\-Button@{Get\-Button}}
\index{Get\-Button@{Get\-Button}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{Get\-Button}]{\setlength{\rightskip}{0pt plus 5cm}bool Xbox\-Joystick\-::\-Get\-Button (
\begin{DoxyParamCaption}
\item[{{\bf Xbox\-Button}}]{button}
\end{DoxyParamCaption}
)}}\label{class_xbox_joystick_a5b6bc91395f531f2d2c3fd4de75ac25c}
Get the current value of the specified button.


\begin{DoxyParams}{Parameters}
{\em button} & The Xbox\-Button to read from. \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
The value of the button. 
\end{DoxyReturn}
\hypertarget{class_xbox_joystick_ac3da3450671b6ceba83b41df7911380d}{\index{Xbox\-Joystick@{Xbox\-Joystick}!Get\-Left\-Trigger@{Get\-Left\-Trigger}}
\index{Get\-Left\-Trigger@{Get\-Left\-Trigger}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{Get\-Left\-Trigger}]{\setlength{\rightskip}{0pt plus 5cm}bool Xbox\-Joystick\-::\-Get\-Left\-Trigger (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_xbox_joystick_ac3da3450671b6ceba83b41df7911380d}
Get whether the left trigger (L\-T) is mostly pressed.

\begin{DoxyReturn}{Returns}
Whether the left trigger (L\-T) is mostly pressed. 
\end{DoxyReturn}
\hypertarget{class_xbox_joystick_a7208078a5e146a0e3775419feb215c30}{\index{Xbox\-Joystick@{Xbox\-Joystick}!Get\-Right\-Trigger@{Get\-Right\-Trigger}}
\index{Get\-Right\-Trigger@{Get\-Right\-Trigger}!XboxJoystick@{Xbox\-Joystick}}
\subsubsection[{Get\-Right\-Trigger}]{\setlength{\rightskip}{0pt plus 5cm}bool Xbox\-Joystick\-::\-Get\-Right\-Trigger (
\begin{DoxyParamCaption}
{}
\end{DoxyParamCaption}
)}}\label{class_xbox_joystick_a7208078a5e146a0e3775419feb215c30}
Get whether the right trigger (R\-T) is mostly pressed.

\begin{DoxyReturn}{Returns}
Whether the right trigger (R\-T) is mostly pressed. 
\end{DoxyReturn}


The documentation for this class was generated from the following files\-:\begin{DoxyCompactItemize}
\item 
C\-:/\-Users/\-Sam/\-Projects/\-F\-R\-C/\-Libraries/\-Fpk/\-Entech-\/\-Fpk-\/\-Subscribers/\-Entech-\/\-Fpk/\-Inputs/Xbox\-Joystick.\-hpp\item 
C\-:/\-Users/\-Sam/\-Projects/\-F\-R\-C/\-Libraries/\-Fpk/\-Entech-\/\-Fpk-\/\-Subscribers/\-Entech-\/\-Fpk/\-Inputs/Xbox\-Joystick.\-cpp\end{DoxyCompactItemize}
